using System.Collections.Generic;

namespace Rhinestone.Domain.Services
{
    /// <summary>
    /// The <see cref="IProjectsSearchService"/> defines a contract that should be 
    /// implemented by a search service that allows searching for projects.
    /// </summary>
    public interface IProjectsSearchService
    {
        /// <summary>
        /// Searches for projects that match of satisfy a search term or text.
        /// </summary>
        /// <param name="searchText">string. The search text used to search for matching 
        /// projects.</param>
        /// <returns>A <see cref="IEnumerable{T}"/> that can be used to enumerate over the
        /// search results.</returns>
        IEnumerable<Project> SearchForProjects(string searchText);
    }
}